Skip to content

docs: add comprehensive error documentation and standardize error response format#30

Open
01programs wants to merge 3 commits intomainfrom
errorcodes
Open

docs: add comprehensive error documentation and standardize error response format#30
01programs wants to merge 3 commits intomainfrom
errorcodes

Conversation

@01programs
Copy link
Copy Markdown
Collaborator

Summary

This PR adds comprehensive error documentation and standardizes the error response format across all OpenAPI specifications.

Changes

New Documentation

  • Added error documentation section with overview page (540+ lines)
  • Added 11 detailed error pages covering all error types:
    • Bad Request (400)
    • Unauthorized (401)
    • Payment Required (402)
    • Forbidden (403)
    • Not Found (404)
    • Unprocessable Entity (422)
    • Idempotency Error (409)
    • Too Many Requests (429)
    • Internal Error (500)
    • Service Unavailable (501)
    • Gateway Timeout (504)
  • Added metadata documentation page with validation rules

OpenAPI Spec Updates

  • Updated all 7 OpenAPI specs to standardize error response format:
    • Moved id field before object field in error schemas
    • Added optional errors array field to all error schemas
    • Updated all error response examples (~60 examples) to match new format
    • Added metadata schema to specs where missing

API Reference Updates

  • Updated 17 API reference pages with:
    • Metadata references and notes
    • Improved descriptions
    • Links to error documentation

Navigation

  • Updated docs.json to include new errors and common objects sections

Files Changed

  • 36 files changed: 3,315 insertions(+), 1,064 deletions(-)
  • 13 new files created
  • 23 files modified

Frederic Schulz added 2 commits January 7, 2026 19:19
…ponse format

- Add error documentation section with overview and 11 detailed error pages
- Add metadata documentation page with validation rules
- Update all OpenAPI specs: standardize error response format (id before object, add errors array)
- Add metadata schema to OpenAPI specs where missing
- Update API reference pages with metadata references and improved descriptions
- Update docs.json navigation to include errors and common objects sections
- Add comprehensive pagination documentation page
- Remove pagination Tip blocks from endpoint MDX files
- Add pagination links to cursor property descriptions in OpenAPI schemas
- Update Maps metadata status from Coming Soon to New
- Add pagination page to sidebar navigation
@01programs 01programs force-pushed the errorcodes branch 2 times, most recently from ec9fdea to 466b0b9 Compare January 8, 2026 19:00
- Update batches/info description with link to items endpoint
- Remove redundant errors section from batches/list
- Enhance answers endpoint description with agent endpoint reference
- Simplify scrapes link filter descriptions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant